Class TensorFlowVersionName (1.1.0)

public sealed class TensorFlowVersionName : IResourceName, IEquatable<TensorFlowVersionName>

Resource name for the TensorFlowVersion resource.

Inheritance

Object > TensorFlowVersionName

Namespace

Google.Cloud.Tpu.V1

Assembly

Google.Cloud.Tpu.V1.dll

Constructors

TensorFlowVersionName(String, String, String)

public TensorFlowVersionName(string projectId, string locationId, string tensorFlowVersionId)

Constructs a new instance of a TensorFlowVersionName class from the component parts of pattern projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorFlowVersionIdString

The TensorFlowVersion ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

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

TensorFlowVersionId

public string TensorFlowVersionId { get; }

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

Property Value
TypeDescription
String

Type

public TensorFlowVersionName.ResourceNameType Type { get; }

The TensorFlowVersionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TensorFlowVersionName.ResourceNameType

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)

public static string Format(string projectId, string locationId, string tensorFlowVersionId)

Formats the IDs into the string representation of this TensorFlowVersionName with pattern projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorFlowVersionIdString

The TensorFlowVersion ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TensorFlowVersionName with pattern projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}.

FormatProjectLocationTensorFlowVersion(String, String, String)

public static string FormatProjectLocationTensorFlowVersion(string projectId, string locationId, string tensorFlowVersionId)

Formats the IDs into the string representation of this TensorFlowVersionName with pattern projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorFlowVersionIdString

The TensorFlowVersion ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this TensorFlowVersionName with pattern projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}.

FromProjectLocationTensorFlowVersion(String, String, String)

public static TensorFlowVersionName FromProjectLocationTensorFlowVersion(string projectId, string locationId, string tensorFlowVersionId)

Creates a TensorFlowVersionName with the pattern projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

tensorFlowVersionIdString

The TensorFlowVersion ID. Must not be null or empty.

Returns
TypeDescription
TensorFlowVersionName

A new instance of TensorFlowVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TensorFlowVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TensorFlowVersionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TensorFlowVersionName

A new instance of TensorFlowVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TensorFlowVersionName Parse(string tensorFlowVersionName)

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

Parameter
NameDescription
tensorFlowVersionNameString

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

Returns
TypeDescription
TensorFlowVersionName

The parsed TensorFlowVersionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}

Parse(String, Boolean)

public static TensorFlowVersionName Parse(string tensorFlowVersionName, bool allowUnparsed)

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

Parameters
NameDescription
tensorFlowVersionNameString

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

allowUnparsedBoolean

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
TensorFlowVersionName

The parsed TensorFlowVersionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/tensorFlowVersions/{tensor_flow_version}
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 TensorFlowVersionName)

public static bool TryParse(string tensorFlowVersionName, out TensorFlowVersionName result)

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

Parameters
NameDescription
tensorFlowVersionNameString

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

resultTensorFlowVersionName

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

Returns
TypeDescription
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}/tensorFlowVersions/{tensor_flow_version}

TryParse(String, Boolean, out TensorFlowVersionName)

public static bool TryParse(string tensorFlowVersionName, bool allowUnparsed, out TensorFlowVersionName result)

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

Parameters
NameDescription
tensorFlowVersionNameString

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

allowUnparsedBoolean

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.

resultTensorFlowVersionName

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

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

Operators

Equality(TensorFlowVersionName, TensorFlowVersionName)

public static bool operator ==(TensorFlowVersionName a, TensorFlowVersionName b)
Parameters
NameDescription
aTensorFlowVersionName
bTensorFlowVersionName
Returns
TypeDescription
Boolean

Inequality(TensorFlowVersionName, TensorFlowVersionName)

public static bool operator !=(TensorFlowVersionName a, TensorFlowVersionName b)
Parameters
NameDescription
aTensorFlowVersionName
bTensorFlowVersionName
Returns
TypeDescription
Boolean