Cloud AI Platform v1 API - Class SpecialistPoolName (3.11.0) 

public sealed class SpecialistPoolName : IResourceName, IEquatable<SpecialistPoolName>

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

Resource name for the SpecialistPool resource.

Inheritance

object > SpecialistPoolName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

SpecialistPoolName(string, string, string)

public SpecialistPoolName(string projectId, string locationId, string specialistPoolId)

Constructs a new instance of a SpecialistPoolName class from the component parts of pattern projects/{project}/locations/{location}/specialistPools/{specialist_pool}

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

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

SpecialistPoolId

public string SpecialistPoolId { get; }

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

Property Value
Type Description
string

Type

public SpecialistPoolName.ResourceNameType Type { get; }

The SpecialistPoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
SpecialistPoolNameResourceNameType

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

Formats the IDs into the string representation of this SpecialistPoolName with pattern projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

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

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

The string representation of this SpecialistPoolName with pattern projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

FormatProjectLocationSpecialistPool(string, string, string)

public static string FormatProjectLocationSpecialistPool(string projectId, string locationId, string specialistPoolId)

Formats the IDs into the string representation of this SpecialistPoolName with pattern projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

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

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

The string representation of this SpecialistPoolName with pattern projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

FromProjectLocationSpecialistPool(string, string, string)

public static SpecialistPoolName FromProjectLocationSpecialistPool(string projectId, string locationId, string specialistPoolId)

Creates a SpecialistPoolName with the pattern projects/{project}/locations/{location}/specialistPools/{specialist_pool}.

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

The SpecialistPool ID. Must not be null or empty.
Returns
Type Description
SpecialistPoolName

A new instance of SpecialistPoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SpecialistPoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SpecialistPoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
specialistPoolName string

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

The parsed SpecialistPoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/specialistPools/{specialist_pool}

Parse(string, bool)

public static SpecialistPoolName Parse(string specialistPoolName, bool allowUnparsed)

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

Parameters
Name Description
specialistPoolName 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
SpecialistPoolName

The parsed SpecialistPoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/specialistPools/{specialist_pool}
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 SpecialistPoolName)

public static bool TryParse(string specialistPoolName, out SpecialistPoolName result)

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

Parameters
Name Description
specialistPoolName string

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

When this method returns, the parsed SpecialistPoolName, 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}/specialistPools/{specialist_pool}

TryParse(string, bool, out SpecialistPoolName)

public static bool TryParse(string specialistPoolName, bool allowUnparsed, out SpecialistPoolName result)

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

Parameters
Name Description
specialistPoolName 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 SpecialistPoolName

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

Operators

operator ==(SpecialistPoolName, SpecialistPoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SpecialistPoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SpecialistPoolName

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

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.