AI Platform Notebooks v1 API - Class TensorboardName (2.2.0)

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

Implements

IResourceName, IEquatable<TensorboardName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`tensorboardId`	`String` 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
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`

TensorboardId

public string TensorboardId { get; }

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

Property Value
Type	Description
`String`

Type

public TensorboardName.ResourceNameType Type { get; }

The TensorboardName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TensorboardName.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 tensorboardId)

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

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.
`tensorboardId`	`String` The `Tensorboard` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`tensorboardId`	`String` The `Tensorboard` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`tensorboardId`	`String` The `Tensorboard` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`TensorboardName`	A new instance of TensorboardName 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 TensorboardName Parse(string tensorboardName)

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

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

Returns
Type	Description
`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
Name	Description
`tensorboardName`	`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
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`tensorboardName`	`String` The resource name in string form. Must not be `null`.
`result`	`TensorboardName` When this method returns, the parsed TensorboardName, 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}/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
Name	Description
`tensorboardName`	`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`	`TensorboardName` When this method returns, the parsed TensorboardName, 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}/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
Name	Description
`a`	`TensorboardName`
`b`	`TensorboardName`

Returns
Type	Description
`Boolean`

Inequality(TensorboardName, TensorboardName)

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

Parameters
Name	Description
`a`	`TensorboardName`
`b`	`TensorboardName`

Returns
Type	Description
`Boolean`