Cloud AI Platform v1 API - Class TensorboardRunName (3.13.0) 

public sealed class TensorboardRunName : IResourceName, IEquatable<TensorboardRunName>

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

Resource name for the TensorboardRun resource.

Inheritance

object > TensorboardRunName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TensorboardRunName(string, string, string, string, string)

public TensorboardRunName(string projectId, string locationId, string tensorboardId, string experimentId, string runId)

Constructs a new instance of a TensorboardRunName class from the component parts of pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

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

The Experiment ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.

Properties

ExperimentId

public string ExperimentId { get; }

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

Property Value
Type Description
string

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

RunId

public string RunId { get; }

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

The TensorboardRunName.ResourceNameType of the contained resource name.

Property Value
Type Description
TensorboardRunNameResourceNameType

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

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

Formats the IDs into the string representation of this TensorboardRunName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} .

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

The Experiment ID. Must not be null or empty.
runId string

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

The string representation of this TensorboardRunName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} .

FormatProjectLocationTensorboardExperimentRun(string, string, string, string, string)

public static string FormatProjectLocationTensorboardExperimentRun(string projectId, string locationId, string tensorboardId, string experimentId, string runId)

Formats the IDs into the string representation of this TensorboardRunName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} .

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

The Experiment ID. Must not be null or empty.
runId string

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

The string representation of this TensorboardRunName with pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} .

FromProjectLocationTensorboardExperimentRun(string, string, string, string, string)

public static TensorboardRunName FromProjectLocationTensorboardExperimentRun(string projectId, string locationId, string tensorboardId, string experimentId, string runId)

Creates a TensorboardRunName with the pattern projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run} .

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

The Experiment ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.
Returns
Type Description
TensorboardRunName

A new instance of TensorboardRunName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TensorboardRunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TensorboardRunName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
tensorboardRunName string

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

The parsed TensorboardRunName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

Parse(string, bool)

public static TensorboardRunName Parse(string tensorboardRunName, bool allowUnparsed)

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

Parameters
Name Description
tensorboardRunName 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
TensorboardRunName

The parsed TensorboardRunName if successful.
Remarks

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

  • projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
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 TensorboardRunName)

public static bool TryParse(string tensorboardRunName, out TensorboardRunName result)

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

Parameters
Name Description
tensorboardRunName string

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

When this method returns, the parsed TensorboardRunName, 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}/experiments/{experiment}/runs/{run}

TryParse(string, bool, out TensorboardRunName)

public static bool TryParse(string tensorboardRunName, bool allowUnparsed, out TensorboardRunName result)

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

Parameters
Name Description
tensorboardRunName 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 TensorboardRunName

When this method returns, the parsed TensorboardRunName, 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}/experiments/{experiment}/runs/{run}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TensorboardRunName, TensorboardRunName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TensorboardRunName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TensorboardRunName

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

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.