- 3.10.0 (latest)
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.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.
Namespace
Google.Cloud.AIPlatform.V1Assembly
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 |
locationId | string The |
studyId | string The |
trialId | string The |
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 |
locationId | string The |
studyId | string The |
trialId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TrialName with pattern
|
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 |
locationId | string The |
studyId | string The |
trialId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TrialName with pattern
|
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 |
locationId | string The |
studyId | string The |
trialId | string The |
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 |
Returns | |
---|---|
Type | Description |
TrialName | A new instance of TrialName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
TrialName | The parsed TrialName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
TrialName | The parsed TrialName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/studies/{study}/trials/{trial}
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 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 |
result | TrialName When this method returns, the parsed TrialName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed | bool If |
result | TrialName When this method returns, the parsed TrialName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/studies/{study}/trials/{trial}
allowUnparsed
is true
.
Operators
operator ==(TrialName, TrialName)
public static bool operator ==(TrialName a, TrialName b)
Parameters | |
---|---|
Name | Description |
a | TrialName |
b | TrialName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(TrialName, TrialName)
public static bool operator !=(TrialName a, TrialName b)
Parameters | |
---|---|
Name | Description |
a | TrialName |
b | TrialName |
Returns | |
---|---|
Type | Description |
bool |