AI Platform Notebooks v1 API - Class RuntimeName (2.1.0)

Version 2.1.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta04

public sealed class RuntimeName : IResourceName, IEquatable<RuntimeName>

Reference documentation and code samples for the AI Platform Notebooks v1 API class RuntimeName.

Resource name for the Runtime resource.

Inheritance

Object > RuntimeName

Implements

IResourceName, IEquatable<RuntimeName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

RuntimeName(String, String, String)

public RuntimeName(string projectId, string locationId, string runtimeId)

Constructs a new instance of a RuntimeName class from the component parts of pattern projects/{project}/locations/{location}/runtimes/{runtime}

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.
runtimeId	String The Runtime 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
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

RuntimeId

public string RuntimeId { get; }

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

Property Value
Type	Description
String

Type

public RuntimeName.ResourceNameType Type { get; }

The RuntimeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
RuntimeName.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 runtimeId)

Formats the IDs into the string representation of this RuntimeName with pattern projects/{project}/locations/{location}/runtimes/{runtime}.

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.
runtimeId	String The Runtime ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this RuntimeName with pattern projects/{project}/locations/{location}/runtimes/{runtime}.

FormatProjectLocationRuntime(String, String, String)

public static string FormatProjectLocationRuntime(string projectId, string locationId, string runtimeId)

Formats the IDs into the string representation of this RuntimeName with pattern projects/{project}/locations/{location}/runtimes/{runtime}.

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.
runtimeId	String The Runtime ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this RuntimeName with pattern projects/{project}/locations/{location}/runtimes/{runtime}.

FromProjectLocationRuntime(String, String, String)

public static RuntimeName FromProjectLocationRuntime(string projectId, string locationId, string runtimeId)

Creates a RuntimeName with the pattern projects/{project}/locations/{location}/runtimes/{runtime}.

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.
runtimeId	String The Runtime ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static RuntimeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RuntimeName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static RuntimeName Parse(string runtimeName)

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

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

Returns
Type	Description
RuntimeName	The parsed RuntimeName if successful.

Remarks

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

• projects/{project}/locations/{location}/runtimes/{runtime}

Parse(String, Boolean)

public static RuntimeName Parse(string runtimeName, bool allowUnparsed)

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

Parameters
Name	Description
runtimeName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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
RuntimeName	The parsed RuntimeName if successful.

Remarks

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

• projects/{project}/locations/{location}/runtimes/{runtime}

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

public static bool TryParse(string runtimeName, out RuntimeName result)

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

Parameters
Name	Description
runtimeName	String The resource name in string form. Must not be null.
result	RuntimeName When this method returns, the parsed RuntimeName, or null if parsing failed.

Returns
Type	Description
Boolean	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}/runtimes/{runtime}

TryParse(String, Boolean, out RuntimeName)

public static bool TryParse(string runtimeName, bool allowUnparsed, out RuntimeName result)

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

Parameters
Name	Description
runtimeName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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	RuntimeName When this method returns, the parsed RuntimeName, or null if parsing failed.

Returns
Type	Description
Boolean	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}/runtimes/{runtime}

Or may be in any format if allowUnparsed is true.

Operators

Equality(RuntimeName, RuntimeName)

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

Parameters
Name	Description
a	RuntimeName
b	RuntimeName

Returns
Type	Description
Boolean

Inequality(RuntimeName, RuntimeName)

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

Parameters
Name	Description
a	RuntimeName
b	RuntimeName

Returns
Type	Description
Boolean