Cloud TPU v1 API - Class AcceleratorTypeName (2.3.0)

public sealed class AcceleratorTypeName : IResourceName, IEquatable<AcceleratorTypeName>

Reference documentation and code samples for the Cloud TPU v1 API class AcceleratorTypeName.

Resource name for the AcceleratorType resource.

Inheritance

object > AcceleratorTypeName

Implements

IResourceName, IEquatable AcceleratorTypeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Tpu.V1

Assembly

Google.Cloud.Tpu.V1.dll

Constructors

AcceleratorTypeName(string, string, string)

public AcceleratorTypeName(string projectId, string locationId, string acceleratorTypeId)

Constructs a new instance of a AcceleratorTypeName class from the component parts of pattern projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}

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

Properties

AcceleratorTypeId

public string AcceleratorTypeId { get; }

The AcceleratorType 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`

Type

public AcceleratorTypeName.ResourceNameType Type { get; }

The AcceleratorTypeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AcceleratorTypeNameResourceNameType`

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)

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

Formats the IDs into the string representation of this AcceleratorTypeName with pattern projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}.

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

Returns
Type	Description
`string`	The string representation of this AcceleratorTypeName with pattern `projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}`.

FormatProjectLocationAcceleratorType(string, string, string)

public static string FormatProjectLocationAcceleratorType(string projectId, string locationId, string acceleratorTypeId)

Formats the IDs into the string representation of this AcceleratorTypeName with pattern projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}.

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

Returns
Type	Description
`string`	The string representation of this AcceleratorTypeName with pattern `projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}`.

FromProjectLocationAcceleratorType(string, string, string)

public static AcceleratorTypeName FromProjectLocationAcceleratorType(string projectId, string locationId, string acceleratorTypeId)

Creates a AcceleratorTypeName with the pattern projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}.

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

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

FromUnparsed(UnparsedResourceName)

public static AcceleratorTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AcceleratorTypeName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
`AcceleratorTypeName`	The parsed AcceleratorTypeName if successful.

Remarks

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

projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}

Parse(string, bool)

public static AcceleratorTypeName Parse(string acceleratorTypeName, bool allowUnparsed)

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

Parameters
Name	Description
`acceleratorTypeName`	`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
`AcceleratorTypeName`	The parsed AcceleratorTypeName if successful.

Remarks

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

projects/{project}/locations/{location}/acceleratorTypes/{accelerator_type}

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

public static bool TryParse(string acceleratorTypeName, out AcceleratorTypeName result)

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

Parameters
Name	Description
`acceleratorTypeName`	`string` The resource name in string form. Must not be `null`.
`result`	`AcceleratorTypeName` When this method returns, the parsed AcceleratorTypeName, 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}/acceleratorTypes/{accelerator_type}

TryParse(string, bool, out AcceleratorTypeName)

public static bool TryParse(string acceleratorTypeName, bool allowUnparsed, out AcceleratorTypeName result)

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

Parameters
Name	Description
`acceleratorTypeName`	`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`	`AcceleratorTypeName` When this method returns, the parsed AcceleratorTypeName, 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}/acceleratorTypes/{accelerator_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AcceleratorTypeName, AcceleratorTypeName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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