Cloud AI Platform v1 API - Class NotebookExecutionJobName (3.11.0) 

public sealed class NotebookExecutionJobName : IResourceName, IEquatable<NotebookExecutionJobName>

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

Resource name for the NotebookExecutionJob resource.

Inheritance

object > NotebookExecutionJobName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

NotebookExecutionJobName(string, string, string)

public NotebookExecutionJobName(string projectId, string locationId, string notebookExecutionJobId)

Constructs a new instance of a NotebookExecutionJobName class from the component parts of pattern projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}

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

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

NotebookExecutionJobId

public string NotebookExecutionJobId { get; }

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

The NotebookExecutionJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
NotebookExecutionJobNameResourceNameType

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

Formats the IDs into the string representation of this NotebookExecutionJobName with pattern projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}.

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

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

The string representation of this NotebookExecutionJobName with pattern projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}.

FormatProjectLocationNotebookExecutionJob(string, string, string)

public static string FormatProjectLocationNotebookExecutionJob(string projectId, string locationId, string notebookExecutionJobId)

Formats the IDs into the string representation of this NotebookExecutionJobName with pattern projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}.

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

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

The string representation of this NotebookExecutionJobName with pattern projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}.

FromProjectLocationNotebookExecutionJob(string, string, string)

public static NotebookExecutionJobName FromProjectLocationNotebookExecutionJob(string projectId, string locationId, string notebookExecutionJobId)

Creates a NotebookExecutionJobName with the pattern projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}.

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

The NotebookExecutionJob ID. Must not be null or empty.
Returns
Type Description
NotebookExecutionJobName

A new instance of NotebookExecutionJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NotebookExecutionJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotebookExecutionJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
notebookExecutionJobName string

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

The parsed NotebookExecutionJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}

Parse(string, bool)

public static NotebookExecutionJobName Parse(string notebookExecutionJobName, bool allowUnparsed)

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

Parameters
Name Description
notebookExecutionJobName 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
NotebookExecutionJobName

The parsed NotebookExecutionJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}
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 NotebookExecutionJobName)

public static bool TryParse(string notebookExecutionJobName, out NotebookExecutionJobName result)

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

Parameters
Name Description
notebookExecutionJobName string

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

When this method returns, the parsed NotebookExecutionJobName, 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}/notebookExecutionJobs/{notebook_execution_job}

TryParse(string, bool, out NotebookExecutionJobName)

public static bool TryParse(string notebookExecutionJobName, bool allowUnparsed, out NotebookExecutionJobName result)

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

Parameters
Name Description
notebookExecutionJobName 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 NotebookExecutionJobName

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

Operators

operator ==(NotebookExecutionJobName, NotebookExecutionJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NotebookExecutionJobName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NotebookExecutionJobName

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

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.