Cloud AI Platform v1 API - Class AnnotationSpecName (2.13.0)

public sealed class AnnotationSpecName : IResourceName, IEquatable<AnnotationSpecName>

Reference documentation and code samples for the Cloud AI Platform v1 API class AnnotationSpecName.

Resource name for the AnnotationSpec resource.

Inheritance

object > AnnotationSpecName

Implements

IResourceName, IEquatable AnnotationSpecName

Inherited Members

object.GetType()

Namespace

Google CloudGoogle.Cloud.AIPlatformV1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

AnnotationSpecName(string, string, string, string)

public AnnotationSpecName(string projectId, string locationId, string datasetId, string annotationSpecId)

Constructs a new instance of a AnnotationSpecName class from the component parts of pattern projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`annotationSpecId`	`string` The `AnnotationSpec` ID. Must not be `null` or empty.

Properties

AnnotationSpecId

public string AnnotationSpecId { get; }

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

Property Value
Type	Description
`string`

DatasetId

public string DatasetId { get; }

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

The AnnotationSpecName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AnnotationSpecNameResourceNameType`

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)

public static string Format(string projectId, string locationId, string datasetId, string annotationSpecId)

Formats the IDs into the string representation of this AnnotationSpecName with pattern projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}.

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`annotationSpecId`	`string` The `AnnotationSpec` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AnnotationSpecName with pattern `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`.

FormatProjectLocationDatasetAnnotationSpec(string, string, string, string)

public static string FormatProjectLocationDatasetAnnotationSpec(string projectId, string locationId, string datasetId, string annotationSpecId)

Formats the IDs into the string representation of this AnnotationSpecName with pattern projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}.

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`annotationSpecId`	`string` The `AnnotationSpec` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AnnotationSpecName with pattern `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`.

FromProjectLocationDatasetAnnotationSpec(string, string, string, string)

public static AnnotationSpecName FromProjectLocationDatasetAnnotationSpec(string projectId, string locationId, string datasetId, string annotationSpecId)

Creates a AnnotationSpecName with the pattern projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}.

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.
`datasetId`	`string` The `Dataset` ID. Must not be `null` or empty.
`annotationSpecId`	`string` The `AnnotationSpec` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AnnotationSpecName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnnotationSpecName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

Parse(string, bool)

public static AnnotationSpecName Parse(string annotationSpecName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}

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

public static bool TryParse(string annotationSpecName, out AnnotationSpecName result)

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

Parameters
Name	Description
`annotationSpecName`	`string` The resource name in string form. Must not be `null`.
`result`	`AnnotationSpecName` When this method returns, the parsed AnnotationSpecName, 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}/datasets/{dataset}/annotationSpecs/{annotation_spec}

TryParse(string, bool, out AnnotationSpecName)

public static bool TryParse(string annotationSpecName, bool allowUnparsed, out AnnotationSpecName result)

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

Parameters
Name	Description
`annotationSpecName`	`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`	`AnnotationSpecName` When this method returns, the parsed AnnotationSpecName, 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}/datasets/{dataset}/annotationSpecs/{annotation_spec}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AnnotationSpecName, AnnotationSpecName)

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

Parameters
Name	Description
`a`	`AnnotationSpecName`
`b`	`AnnotationSpecName`

Returns
Type	Description
`bool`

operator !=(AnnotationSpecName, AnnotationSpecName)

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

Parameters
Name	Description
`a`	`AnnotationSpecName`
`b`	`AnnotationSpecName`

Returns
Type	Description
`bool`