- 3.7.0 (latest)
- 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 StudyName : IResourceName, IEquatable<StudyName>
Reference documentation and code samples for the Cloud AI Platform v1 API class StudyName.
Resource name for the Study
resource.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
StudyName(String, String, String)
public StudyName(string projectId, string locationId, string studyId)
Constructs a new instance of a StudyName class from the component parts of pattern
projects/{project}/locations/{location}/studies/{study}
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
studyId | String The |
Properties
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
Boolean |
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 |
Type
public StudyName.ResourceNameType Type { get; }
The StudyName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
StudyName.ResourceNameType |
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 studyId)
Formats the IDs into the string representation of this StudyName with pattern
projects/{project}/locations/{location}/studies/{study}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
studyId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this StudyName with pattern
|
FormatProjectLocationStudy(String, String, String)
public static string FormatProjectLocationStudy(string projectId, string locationId, string studyId)
Formats the IDs into the string representation of this StudyName with pattern
projects/{project}/locations/{location}/studies/{study}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
studyId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this StudyName with pattern
|
FromProjectLocationStudy(String, String, String)
public static StudyName FromProjectLocationStudy(string projectId, string locationId, string studyId)
Creates a StudyName with the pattern
projects/{project}/locations/{location}/studies/{study}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
studyId | String The |
Returns | |
---|---|
Type | Description |
StudyName | A new instance of StudyName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static StudyName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a StudyName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
StudyName | A new instance of StudyName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static StudyName Parse(string studyName)
Parses the given resource name string into a new StudyName instance.
Parameter | |
---|---|
Name | Description |
studyName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
StudyName | The parsed StudyName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/studies/{study}
Parse(String, Boolean)
public static StudyName Parse(string studyName, bool allowUnparsed)
Parses the given resource name string into a new StudyName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
studyName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
StudyName | The parsed StudyName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/studies/{study}
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 StudyName)
public static bool TryParse(string studyName, out StudyName result)
Tries to parse the given resource name string into a new StudyName instance.
Parameters | |
---|---|
Name | Description |
studyName | String The resource name in string form. Must not be |
result | StudyName When this method returns, the parsed StudyName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/studies/{study}
TryParse(String, Boolean, out StudyName)
public static bool TryParse(string studyName, bool allowUnparsed, out StudyName result)
Tries to parse the given resource name string into a new StudyName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
studyName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | StudyName When this method returns, the parsed StudyName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/studies/{study}
allowUnparsed
is true
.
Operators
Equality(StudyName, StudyName)
public static bool operator ==(StudyName a, StudyName b)
Parameters | |
---|---|
Name | Description |
a | StudyName |
b | StudyName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(StudyName, StudyName)
public static bool operator !=(StudyName a, StudyName b)
Parameters | |
---|---|
Name | Description |
a | StudyName |
b | StudyName |
Returns | |
---|---|
Type | Description |
Boolean |