- 3.7.0 (latest)
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.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.
Namespace
Google.Cloud.AIPlatform.V1Assembly
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 |
locationId | string The |
tensorboardId | string The |
experimentId | string The |
runId | string The |
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 |
locationId | string The |
tensorboardId | string The |
experimentId | string The |
runId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TensorboardRunName with pattern
|
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 |
locationId | string The |
tensorboardId | string The |
experimentId | string The |
runId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this TensorboardRunName with pattern
|
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 |
locationId | string The |
tensorboardId | string The |
experimentId | string The |
runId | string The |
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 |
Returns | |
---|---|
Type | Description |
TensorboardRunName | A new instance of TensorboardRunName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
TensorboardRunName | The parsed TensorboardRunName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
TensorboardRunName | The parsed TensorboardRunName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
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. |
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 |
result | TensorboardRunName When this method returns, the parsed TensorboardRunName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed | bool If |
result | TensorboardRunName When this method returns, the parsed TensorboardRunName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
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 |
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 |