Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class TensorboardExperimentName (1.4.0)

public sealed class TensorboardExperimentName : IResourceName, IEquatable<TensorboardExperimentName>

Resource name for the TensorboardExperiment resource.

Inheritance

Object > TensorboardExperimentName

Implements

IResourceName, IEquatable<TensorboardExperimentName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TensorboardExperimentName(String, String, String, String)

public TensorboardExperimentName(string projectId, string locationId, string tensorboardId, string experimentId)

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

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.

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
`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 TensorboardExperimentName.ResourceNameType Type { get; }

The TensorboardExperimentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TensorboardExperimentName.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, String)

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

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

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.

Returns
Type	Description
`String`	The string representation of this TensorboardExperimentName with pattern `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`.

FormatProjectLocationTensorboardExperiment(String, String, String, String)

public static string FormatProjectLocationTensorboardExperiment(string projectId, string locationId, string tensorboardId, string experimentId)

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

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.

Returns
Type	Description
`String`	The string representation of this TensorboardExperimentName with pattern `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`.

FromProjectLocationTensorboardExperiment(String, String, String, String)

public static TensorboardExperimentName FromProjectLocationTensorboardExperiment(string projectId, string locationId, string tensorboardId, string experimentId)

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

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.

Returns
Type	Description
`TensorboardExperimentName`	A new instance of TensorboardExperimentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TensorboardExperimentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TensorboardExperimentName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

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

Returns
Type	Description
`TensorboardExperimentName`	The parsed TensorboardExperimentName 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}

Parse(String, Boolean)

public static TensorboardExperimentName Parse(string tensorboardExperimentName, bool allowUnparsed)

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

Parameters
Name	Description
`tensorboardExperimentName`	`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
`TensorboardExperimentName`	The parsed TensorboardExperimentName 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}

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

public static bool TryParse(string tensorboardExperimentName, out TensorboardExperimentName result)

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

Parameters
Name	Description
`tensorboardExperimentName`	`String` The resource name in string form. Must not be `null`.
`result`	`TensorboardExperimentName` When this method returns, the parsed TensorboardExperimentName, 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}/experiments/{experiment}

TryParse(String, Boolean, out TensorboardExperimentName)

public static bool TryParse(string tensorboardExperimentName, bool allowUnparsed, out TensorboardExperimentName result)

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

Parameters
Name	Description
`tensorboardExperimentName`	`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`	`TensorboardExperimentName` When this method returns, the parsed TensorboardExperimentName, 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}/experiments/{experiment}

Or may be in any format if allowUnparsed is true.

Operators

Equality(TensorboardExperimentName, TensorboardExperimentName)

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

Parameters
Name	Description
`a`	`TensorboardExperimentName`
`b`	`TensorboardExperimentName`

Returns
Type	Description
`Boolean`

Inequality(TensorboardExperimentName, TensorboardExperimentName)

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

Parameters
Name	Description
`a`	`TensorboardExperimentName`
`b`	`TensorboardExperimentName`

Returns
Type	Description
`Boolean`