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

public sealed class NotebookRuntimeName : IResourceName, IEquatable<NotebookRuntimeName>

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

Resource name for the NotebookRuntime resource.

Inheritance

object > NotebookRuntimeName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

NotebookRuntimeName(string, string, string)

public NotebookRuntimeName(string projectId, string locationId, string notebookRuntimeId)

Constructs a new instance of a NotebookRuntimeName class from the component parts of pattern projects/{project}/locations/{location}/notebookRuntimes/{notebook_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.
notebookRuntimeId string

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

NotebookRuntimeId

public string NotebookRuntimeId { get; }

The NotebookRuntime 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 NotebookRuntimeName.ResourceNameType Type { get; }

The NotebookRuntimeName.ResourceNameType of the contained resource name.

Property Value
Type Description
NotebookRuntimeNameResourceNameType

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

Formats the IDs into the string representation of this NotebookRuntimeName with pattern projects/{project}/locations/{location}/notebookRuntimes/{notebook_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.
notebookRuntimeId string

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

The string representation of this NotebookRuntimeName with pattern projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}.

FormatProjectLocationNotebookRuntime(string, string, string)

public static string FormatProjectLocationNotebookRuntime(string projectId, string locationId, string notebookRuntimeId)

Formats the IDs into the string representation of this NotebookRuntimeName with pattern projects/{project}/locations/{location}/notebookRuntimes/{notebook_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.
notebookRuntimeId string

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

The string representation of this NotebookRuntimeName with pattern projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}.

FromProjectLocationNotebookRuntime(string, string, string)

public static NotebookRuntimeName FromProjectLocationNotebookRuntime(string projectId, string locationId, string notebookRuntimeId)

Creates a NotebookRuntimeName with the pattern projects/{project}/locations/{location}/notebookRuntimes/{notebook_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.
notebookRuntimeId string

The NotebookRuntime ID. Must not be null or empty.
Returns
Type Description
NotebookRuntimeName

A new instance of NotebookRuntimeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NotebookRuntimeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotebookRuntimeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
notebookRuntimeName string

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

The parsed NotebookRuntimeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}

Parse(string, bool)

public static NotebookRuntimeName Parse(string notebookRuntimeName, bool allowUnparsed)

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

Parameters
Name Description
notebookRuntimeName 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
NotebookRuntimeName

The parsed NotebookRuntimeName if successful.
Remarks

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

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

TryParse(string, out NotebookRuntimeName)

public static bool TryParse(string notebookRuntimeName, out NotebookRuntimeName result)

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

Parameters
Name Description
notebookRuntimeName string

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

When this method returns, the parsed NotebookRuntimeName, 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}/notebookRuntimes/{notebook_runtime}

TryParse(string, bool, out NotebookRuntimeName)

public static bool TryParse(string notebookRuntimeName, bool allowUnparsed, out NotebookRuntimeName result)

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

Parameters
Name Description
notebookRuntimeName 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 NotebookRuntimeName

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

Operators

operator ==(NotebookRuntimeName, NotebookRuntimeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NotebookRuntimeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NotebookRuntimeName

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

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.