AI Platform Notebooks v1 API - Class TensorboardName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class TensorboardName : IResourceName, IEquatable<TensorboardName>

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

Resource name for the Tensorboard resource.

Inheritance

Object > TensorboardName

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

TensorboardName(String, String, String)

public TensorboardName(string projectId, string locationId, string tensorboardId)

Constructs a new instance of a TensorboardName class from the component parts of pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorboardIdString

The Tensorboard 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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

TensorboardId

public string TensorboardId { get; }

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

Property Value
TypeDescription
String

Type

public TensorboardName.ResourceNameType Type { get; }

The TensorboardName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TensorboardName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

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

Formats the IDs into the string representation of this TensorboardName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorboardIdString

The Tensorboard ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TensorboardName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}.

FormatProjectLocationTensorboard(String, String, String)

public static string FormatProjectLocationTensorboard(string projectId, string locationId, string tensorboardId)

Formats the IDs into the string representation of this TensorboardName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorboardIdString

The Tensorboard ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TensorboardName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}.

FromProjectLocationTensorboard(String, String, String)

public static TensorboardName FromProjectLocationTensorboard(string projectId, string locationId, string tensorboardId)

Creates a TensorboardName with the pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorboardIdString

The Tensorboard ID. Must not be null or empty.

Returns
TypeDescription
TensorboardName

A new instance of TensorboardName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TensorboardName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TensorboardName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TensorboardName

A new instance of TensorboardName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TensorboardName Parse(string tensorboardName)

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

Parameter
NameDescription
tensorboardNameString

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

Returns
TypeDescription
TensorboardName

The parsed TensorboardName if successful.

Remarks

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

  • projects/{project}/locations/{location}/tensorboards/{tensorboard}

Parse(String, Boolean)

public static TensorboardName Parse(string tensorboardName, bool allowUnparsed)

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

Parameters
NameDescription
tensorboardNameString

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

allowUnparsedBoolean

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
TypeDescription
TensorboardName

The parsed TensorboardName if successful.

Remarks

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

  • projects/{project}/locations/{location}/tensorboards/{tensorboard}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out TensorboardName)

public static bool TryParse(string tensorboardName, out TensorboardName result)

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

Parameters
NameDescription
tensorboardNameString

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

resultTensorboardName

When this method returns, the parsed TensorboardName, or null if parsing failed.

Returns
TypeDescription
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}/tensorboards/{tensorboard}

TryParse(String, Boolean, out TensorboardName)

public static bool TryParse(string tensorboardName, bool allowUnparsed, out TensorboardName result)

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

Parameters
NameDescription
tensorboardNameString

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

allowUnparsedBoolean

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.

resultTensorboardName

When this method returns, the parsed TensorboardName, or null if parsing failed.

Returns
TypeDescription
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}/tensorboards/{tensorboard}
Or may be in any format if allowUnparsed is true.

Operators

Equality(TensorboardName, TensorboardName)

public static bool operator ==(TensorboardName a, TensorboardName b)
Parameters
NameDescription
aTensorboardName
bTensorboardName
Returns
TypeDescription
Boolean

Inequality(TensorboardName, TensorboardName)

public static bool operator !=(TensorboardName a, TensorboardName b)
Parameters
NameDescription
aTensorboardName
bTensorboardName
Returns
TypeDescription
Boolean