Cloud AI Platform v1 API - Class NotebookRuntimeTemplateName (3.8.0) 

public sealed class NotebookRuntimeTemplateName : IResourceName, IEquatable<NotebookRuntimeTemplateName>

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

Resource name for the NotebookRuntimeTemplate resource.

Inheritance

object > NotebookRuntimeTemplateName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

NotebookRuntimeTemplateName(string, string, string)

public NotebookRuntimeTemplateName(string projectId, string locationId, string notebookRuntimeTemplateId)

Constructs a new instance of a NotebookRuntimeTemplateName class from the component parts of pattern projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}

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

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

NotebookRuntimeTemplateId

public string NotebookRuntimeTemplateId { get; }

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

The NotebookRuntimeTemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
NotebookRuntimeTemplateNameResourceNameType

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

Formats the IDs into the string representation of this NotebookRuntimeTemplateName with pattern projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}.

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

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

The string representation of this NotebookRuntimeTemplateName with pattern projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}.

FormatProjectLocationNotebookRuntimeTemplate(string, string, string)

public static string FormatProjectLocationNotebookRuntimeTemplate(string projectId, string locationId, string notebookRuntimeTemplateId)

Formats the IDs into the string representation of this NotebookRuntimeTemplateName with pattern projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}.

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

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

The string representation of this NotebookRuntimeTemplateName with pattern projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}.

FromProjectLocationNotebookRuntimeTemplate(string, string, string)

public static NotebookRuntimeTemplateName FromProjectLocationNotebookRuntimeTemplate(string projectId, string locationId, string notebookRuntimeTemplateId)

Creates a NotebookRuntimeTemplateName with the pattern projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}.

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

The NotebookRuntimeTemplate ID. Must not be null or empty.
Returns
Type Description
NotebookRuntimeTemplateName

A new instance of NotebookRuntimeTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NotebookRuntimeTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotebookRuntimeTemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
notebookRuntimeTemplateName string

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

The parsed NotebookRuntimeTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}

Parse(string, bool)

public static NotebookRuntimeTemplateName Parse(string notebookRuntimeTemplateName, bool allowUnparsed)

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

Parameters
Name Description
notebookRuntimeTemplateName 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
NotebookRuntimeTemplateName

The parsed NotebookRuntimeTemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}
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 NotebookRuntimeTemplateName)

public static bool TryParse(string notebookRuntimeTemplateName, out NotebookRuntimeTemplateName result)

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

Parameters
Name Description
notebookRuntimeTemplateName string

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

When this method returns, the parsed NotebookRuntimeTemplateName, 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}/notebookRuntimeTemplates/{notebook_runtime_template}

TryParse(string, bool, out NotebookRuntimeTemplateName)

public static bool TryParse(string notebookRuntimeTemplateName, bool allowUnparsed, out NotebookRuntimeTemplateName result)

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

Parameters
Name Description
notebookRuntimeTemplateName 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 NotebookRuntimeTemplateName

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

Operators

operator ==(NotebookRuntimeTemplateName, NotebookRuntimeTemplateName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NotebookRuntimeTemplateName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NotebookRuntimeTemplateName

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

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.