Infrastructure Manager v1 API - Class WarmPoolName (1.13.0)

1.13.0 (latest) 1.12.0 1.11.0 1.10.0 1.9.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 WarmPoolName : IResourceName, IEquatable<WarmPoolName>

Reference documentation and code samples for the Infrastructure Manager v1 API class WarmPoolName.

Resource name for the WarmPool resource.

Inheritance

object > WarmPoolName

Implements

IResourceName, IEquatableWarmPoolName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

WarmPoolName(string, string, string)

public WarmPoolName(string projectId, string locationId, string warmPoolId)

Constructs a new instance of a WarmPoolName class from the component parts of pattern projects/{project}/locations/{location}/warmPools/{warm_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.
warmPoolId	string The WarmPool 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

Type

public WarmPoolName.ResourceNameType Type { get; }

The WarmPoolName.ResourceNameType of the contained resource name.

Property Value
Type	Description
WarmPoolNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
UnparsedResourceName

WarmPoolId

public string WarmPoolId { get; }

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

Property Value
Type	Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string warmPoolId)

Formats the IDs into the string representation of this WarmPoolName with pattern projects/{project}/locations/{location}/warmPools/{warm_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.
warmPoolId	string The WarmPool ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this WarmPoolName with pattern projects/{project}/locations/{location}/warmPools/{warm_pool}.

FormatProjectLocationWarmPool(string, string, string)

public static string FormatProjectLocationWarmPool(string projectId, string locationId, string warmPoolId)

Formats the IDs into the string representation of this WarmPoolName with pattern projects/{project}/locations/{location}/warmPools/{warm_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.
warmPoolId	string The WarmPool ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this WarmPoolName with pattern projects/{project}/locations/{location}/warmPools/{warm_pool}.

FromProjectLocationWarmPool(string, string, string)

public static WarmPoolName FromProjectLocationWarmPool(string projectId, string locationId, string warmPoolId)

Creates a WarmPoolName with the pattern projects/{project}/locations/{location}/warmPools/{warm_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.
warmPoolId	string The WarmPool ID. Must not be null or empty.

Returns
Type	Description
WarmPoolName	A new instance of WarmPoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WarmPoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WarmPoolName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
WarmPoolName	A new instance of WarmPoolName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static WarmPoolName Parse(string warmPoolName)

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

Parameter
Name	Description
warmPoolName	string The resource name in string form. Must not be null.

Returns
Type	Description
WarmPoolName	The parsed WarmPoolName if successful.

Remarks

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

• projects/{project}/locations/{location}/warmPools/{warm_pool}

Parse(string, bool)

public static WarmPoolName Parse(string warmPoolName, bool allowUnparsed)

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

Parameters
Name	Description
warmPoolName	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
WarmPoolName	The parsed WarmPoolName if successful.

Remarks

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

• projects/{project}/locations/{location}/warmPools/{warm_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

object.ToString()

TryParse(string, out WarmPoolName)

public static bool TryParse(string warmPoolName, out WarmPoolName result)

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

Parameters
Name	Description
warmPoolName	string The resource name in string form. Must not be null.
result	WarmPoolName When this method returns, the parsed WarmPoolName, 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}/warmPools/{warm_pool}

TryParse(string, bool, out WarmPoolName)

public static bool TryParse(string warmPoolName, bool allowUnparsed, out WarmPoolName result)

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

Parameters
Name	Description
warmPoolName	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	WarmPoolName When this method returns, the parsed WarmPoolName, 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}/warmPools/{warm_pool}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(WarmPoolName, WarmPoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	WarmPoolName The first resource name to compare, or null.
b	WarmPoolName 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 !=(WarmPoolName, WarmPoolName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	WarmPoolName The first resource name to compare, or null.
b	WarmPoolName 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.