Cloud AI Platform v1beta1 API - Class DeploymentResourcePoolName (1.0.0-beta09) 

public sealed class DeploymentResourcePoolName : IResourceName, IEquatable<DeploymentResourcePoolName>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class DeploymentResourcePoolName.

Resource name for the DeploymentResourcePool resource.

Inheritance

object > DeploymentResourcePoolName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

DeploymentResourcePoolName(string, string, string)

public DeploymentResourcePoolName(string projectId, string locationId, string deploymentResourcePoolId)

Constructs a new instance of a DeploymentResourcePoolName class from the component parts of pattern projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_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.
deploymentResourcePoolId string

The DeploymentResourcePool ID. Must not be null or empty.

Properties

DeploymentResourcePoolId

public string DeploymentResourcePoolId { get; }

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

Property Value
Type Description
string

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

Type

public DeploymentResourcePoolName.ResourceNameType Type { get; }

The DeploymentResourcePoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
DeploymentResourcePoolNameResourceNameType

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

Formats the IDs into the string representation of this DeploymentResourcePoolName with pattern projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_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.
deploymentResourcePoolId string

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

The string representation of this DeploymentResourcePoolName with pattern projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}.

FormatProjectLocationDeploymentResourcePool(string, string, string)

public static string FormatProjectLocationDeploymentResourcePool(string projectId, string locationId, string deploymentResourcePoolId)

Formats the IDs into the string representation of this DeploymentResourcePoolName with pattern projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_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.
deploymentResourcePoolId string

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

The string representation of this DeploymentResourcePoolName with pattern projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}.

FromProjectLocationDeploymentResourcePool(string, string, string)

public static DeploymentResourcePoolName FromProjectLocationDeploymentResourcePool(string projectId, string locationId, string deploymentResourcePoolId)

Creates a DeploymentResourcePoolName with the pattern projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_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.
deploymentResourcePoolId string

The DeploymentResourcePool ID. Must not be null or empty.
Returns
Type Description
DeploymentResourcePoolName

A new instance of DeploymentResourcePoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DeploymentResourcePoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeploymentResourcePoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
deploymentResourcePoolName string

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

The parsed DeploymentResourcePoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Parse(string, bool)

public static DeploymentResourcePoolName Parse(string deploymentResourcePoolName, bool allowUnparsed)

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

Parameters
Name Description
deploymentResourcePoolName 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
DeploymentResourcePoolName

The parsed DeploymentResourcePoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_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 DeploymentResourcePoolName)

public static bool TryParse(string deploymentResourcePoolName, out DeploymentResourcePoolName result)

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

Parameters
Name Description
deploymentResourcePoolName string

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

When this method returns, the parsed DeploymentResourcePoolName, 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}/deploymentResourcePools/{deployment_resource_pool}

TryParse(string, bool, out DeploymentResourcePoolName)

public static bool TryParse(string deploymentResourcePoolName, bool allowUnparsed, out DeploymentResourcePoolName result)

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

Parameters
Name Description
deploymentResourcePoolName 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 DeploymentResourcePoolName

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

Operators

operator ==(DeploymentResourcePoolName, DeploymentResourcePoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DeploymentResourcePoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DeploymentResourcePoolName

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

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.