Google Cloud Speech v1 API - Class CustomClassName (3.5.0)

public sealed class CustomClassName : IResourceName, IEquatable<CustomClassName>

Reference documentation and code samples for the Google Cloud Speech v1 API class CustomClassName.

Resource name for the CustomClass resource.

Inheritance

object > CustomClassName

Implements

IResourceName, IEquatable CustomClassName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Speech.V1

Assembly

Google.Cloud.Speech.V1.dll

Constructors

CustomClassName(string, string, string)

public CustomClassName(string projectId, string locationId, string customClassId)

Constructs a new instance of a CustomClassName class from the component parts of pattern projects/{project}/locations/{location}/customClasses/{custom_class}

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

Properties

CustomClassId

public string CustomClassId { get; }

The CustomClass 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 CustomClassName.ResourceNameType Type { get; }

The CustomClassName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CustomClassNameResourceNameType`

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

Formats the IDs into the string representation of this CustomClassName with pattern projects/{project}/locations/{location}/customClasses/{custom_class}.

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

Returns
Type	Description
`string`	The string representation of this CustomClassName with pattern `projects/{project}/locations/{location}/customClasses/{custom_class}`.

FormatProjectLocationCustomClass(string, string, string)

public static string FormatProjectLocationCustomClass(string projectId, string locationId, string customClassId)

Formats the IDs into the string representation of this CustomClassName with pattern projects/{project}/locations/{location}/customClasses/{custom_class}.

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

Returns
Type	Description
`string`	The string representation of this CustomClassName with pattern `projects/{project}/locations/{location}/customClasses/{custom_class}`.

FromProjectLocationCustomClass(string, string, string)

public static CustomClassName FromProjectLocationCustomClass(string projectId, string locationId, string customClassId)

Creates a CustomClassName with the pattern projects/{project}/locations/{location}/customClasses/{custom_class}.

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

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

FromUnparsed(UnparsedResourceName)

public static CustomClassName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CustomClassName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/customClasses/{custom_class}

Parse(string, bool)

public static CustomClassName Parse(string customClassName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/customClasses/{custom_class}

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

public static bool TryParse(string customClassName, out CustomClassName result)

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

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

TryParse(string, bool, out CustomClassName)

public static bool TryParse(string customClassName, bool allowUnparsed, out CustomClassName result)

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

Parameters
Name	Description
`customClassName`	`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`	`CustomClassName` When this method returns, the parsed CustomClassName, 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}/customClasses/{custom_class}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomClassName, CustomClassName)

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

Parameters
Name	Description
`a`	`CustomClassName`
`b`	`CustomClassName`

Returns
Type	Description
`bool`

operator !=(CustomClassName, CustomClassName)

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

Parameters
Name	Description
`a`	`CustomClassName`
`b`	`CustomClassName`

Returns
Type	Description
`bool`