Cloud AI Platform v1 API - Class TensorboardTimeSeriesName (2.23.0)

public sealed class TensorboardTimeSeriesName : IResourceName, IEquatable<TensorboardTimeSeriesName>

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

Resource name for the TensorboardTimeSeries resource.

Inheritance

object > TensorboardTimeSeriesName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TensorboardTimeSeriesName(string, string, string, string, string, string)

public TensorboardTimeSeriesName(string projectId, string locationId, string tensorboardId, string experimentId, string runId, string timeSeriesId)

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

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.

experimentIdstring

The Experiment ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

timeSeriesIdstring

The TimeSeries 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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

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

RunId

public string RunId { get; }

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

TimeSeriesId

public string TimeSeriesId { get; }

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

Property Value
TypeDescription
string

Type

public TensorboardTimeSeriesName.ResourceNameType Type { get; }

The TensorboardTimeSeriesName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TensorboardTimeSeriesNameResourceNameType

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

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

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

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.

experimentIdstring

The Experiment ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

timeSeriesIdstring

The TimeSeries ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationTensorboardExperimentRunTimeSeries(string, string, string, string, string, string)

public static string FormatProjectLocationTensorboardExperimentRunTimeSeries(string projectId, string locationId, string tensorboardId, string experimentId, string runId, string timeSeriesId)

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

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.

experimentIdstring

The Experiment ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

timeSeriesIdstring

The TimeSeries ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationTensorboardExperimentRunTimeSeries(string, string, string, string, string, string)

public static TensorboardTimeSeriesName FromProjectLocationTensorboardExperimentRunTimeSeries(string projectId, string locationId, string tensorboardId, string experimentId, string runId, string timeSeriesId)

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

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.

experimentIdstring

The Experiment ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

timeSeriesIdstring

The TimeSeries ID. Must not be null or empty.

Returns
TypeDescription
TensorboardTimeSeriesName

A new instance of TensorboardTimeSeriesName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TensorboardTimeSeriesName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TensorboardTimeSeriesName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TensorboardTimeSeriesName

A new instance of TensorboardTimeSeriesName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TensorboardTimeSeriesName Parse(string tensorboardTimeSeriesName)

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

Parameter
NameDescription
tensorboardTimeSeriesNamestring

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

Returns
TypeDescription
TensorboardTimeSeriesName

The parsed TensorboardTimeSeriesName 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}/timeSeries/{time_series}

Parse(string, bool)

public static TensorboardTimeSeriesName Parse(string tensorboardTimeSeriesName, bool allowUnparsed)

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

Parameters
NameDescription
tensorboardTimeSeriesNamestring

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

allowUnparsedbool

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
TensorboardTimeSeriesName

The parsed TensorboardTimeSeriesName 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}/timeSeries/{time_series}
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 TensorboardTimeSeriesName)

public static bool TryParse(string tensorboardTimeSeriesName, out TensorboardTimeSeriesName result)

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

Parameters
NameDescription
tensorboardTimeSeriesNamestring

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

resultTensorboardTimeSeriesName

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

Returns
TypeDescription
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}/timeSeries/{time_series}

TryParse(string, bool, out TensorboardTimeSeriesName)

public static bool TryParse(string tensorboardTimeSeriesName, bool allowUnparsed, out TensorboardTimeSeriesName result)

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

Parameters
NameDescription
tensorboardTimeSeriesNamestring

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

allowUnparsedbool

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.

resultTensorboardTimeSeriesName

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

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

Operators

operator ==(TensorboardTimeSeriesName, TensorboardTimeSeriesName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aTensorboardTimeSeriesName

The first resource name to compare, or null.

bTensorboardTimeSeriesName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TensorboardTimeSeriesName, TensorboardTimeSeriesName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aTensorboardTimeSeriesName

The first resource name to compare, or null.

bTensorboardTimeSeriesName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.