Cloud AI Platform v1 API - Class StudyName (2.27.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.

Inheritance

object > StudyName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

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

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

Type

public StudyName.ResourceNameType Type { get; }

The StudyName.ResourceNameType of the contained resource name.

Property Value
Type Description
StudyNameResourceNameType

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 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.
Returns
Type Description
string

The string representation of this StudyName with pattern projects/{project}/locations/{location}/studies/{study}.

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 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.
Returns
Type Description
string

The string representation of this StudyName with pattern projects/{project}/locations/{location}/studies/{study}.

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 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.
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 null.
Returns
Type Description
StudyName

A new instance of StudyName 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 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 null.
Returns
Type Description
StudyName

The parsed StudyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/studies/{study}

Parse(string, bool)

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 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
StudyName

The parsed StudyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/studies/{study}
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 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 null.
result StudyName

When this method returns, the parsed StudyName, 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}

TryParse(string, bool, 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 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 StudyName

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

Operators

operator ==(StudyName, StudyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StudyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StudyName

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

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.