Cloud AI Platform v1beta1 API - Class TensorboardTimeSeriesName (1.0.0-beta05)

public sealed class TensorboardTimeSeriesName : IResourceName, IEquatable<TensorboardTimeSeriesName>

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

Resource name for the TensorboardTimeSeries resource.

Inheritance

object > TensorboardTimeSeriesName

Implements

IResourceName, IEquatable TensorboardTimeSeriesName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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
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.
`timeSeriesId`	`string` 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
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`

TimeSeriesId

public string TimeSeriesId { get; }

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

Property Value
Type	Description
`string`

Type

public TensorboardTimeSeriesName.ResourceNameType Type { get; }

The TensorboardTimeSeriesName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TensorboardTimeSeriesNameResourceNameType`

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, 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
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.
`timeSeriesId`	`string` The `TimeSeries` ID. Must not be `null` or empty.

Returns
Type	Description
`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)

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.
`timeSeriesId`	`string` The `TimeSeries` ID. Must not be `null` or empty.

Returns
Type	Description
`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
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.
`timeSeriesId`	`string` The `TimeSeries` ID. Must not be `null` or empty.

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

Returns
Type	Description
`TensorboardTimeSeriesName`	A new instance of TensorboardTimeSeriesName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static TensorboardTimeSeriesName Parse(string tensorboardTimeSeriesName)

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

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

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

Overrides

object.ToString()

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
Name	Description
`tensorboardTimeSeriesName`	`string` The resource name in string form. Must not be `null`.
`result`	`TensorboardTimeSeriesName` When this method returns, the parsed TensorboardTimeSeriesName, 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}/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
Name	Description
`tensorboardTimeSeriesName`	`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`	`TensorboardTimeSeriesName` When this method returns, the parsed TensorboardTimeSeriesName, 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}/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
Name	Description
`a`	`TensorboardTimeSeriesName` The first resource name to compare, or null.
`b`	`TensorboardTimeSeriesName` 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 !=(TensorboardTimeSeriesName, TensorboardTimeSeriesName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TensorboardTimeSeriesName` The first resource name to compare, or null.
`b`	`TensorboardTimeSeriesName` 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.