Class AcceleratorTypeName (2.0.0) 

public sealed class AcceleratorTypeName : IResourceName, IEquatable<AcceleratorTypeName>

Resource name for the AcceleratorType resource.

Inheritance

Object > AcceleratorTypeName

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

Type

public AcceleratorTypeName.ResourceNameType Type { get; }

The AcceleratorTypeName.ResourceNameType of the contained resource name.

Property Value
Type Description
AcceleratorTypeName.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)

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
Int32
Overrides

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, Boolean)

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

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
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}/acceleratorTypes/{accelerator_type}

TryParse(String, Boolean, 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 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 AcceleratorTypeName

When this method returns, the parsed AcceleratorTypeName, 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}/acceleratorTypes/{accelerator_type}
Or may be in any format if allowUnparsed is true.

Operators

Equality(AcceleratorTypeName, AcceleratorTypeName)

public static bool operator ==(AcceleratorTypeName a, AcceleratorTypeName b)
Parameters
Name Description
a AcceleratorTypeName
b AcceleratorTypeName
Returns
Type Description
Boolean

Inequality(AcceleratorTypeName, AcceleratorTypeName)

public static bool operator !=(AcceleratorTypeName a, AcceleratorTypeName b)
Parameters
Name Description
a AcceleratorTypeName
b AcceleratorTypeName
Returns
Type Description
Boolean