Cloud AI Platform v1 API - Class TensorboardName (3.11.0) 

public sealed class TensorboardName : IResourceName, IEquatable<TensorboardName>

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

Resource name for the Tensorboard resource.

Inheritance

object > TensorboardName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.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
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

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
TensorboardNameResourceNameType

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
int
Overrides

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, bool)

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

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

TryParse(string, bool, 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 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 TensorboardName

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

Operators

operator ==(TensorboardName, TensorboardName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TensorboardName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TensorboardName

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

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.