Data Labeling v1beta1 API - Class AnnotationSpecSetName (2.0.0-beta03)

public sealed class AnnotationSpecSetName : IResourceName, IEquatable<AnnotationSpecSetName>

Reference documentation and code samples for the Data Labeling v1beta1 API class AnnotationSpecSetName.

Resource name for the AnnotationSpecSet resource.

Inheritance

object > AnnotationSpecSetName

Implements

IResourceName, IEquatable AnnotationSpecSetName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

AnnotationSpecSetName(string, string)

public AnnotationSpecSetName(string projectId, string annotationSpecSetId)

Constructs a new instance of a AnnotationSpecSetName class from the component parts of pattern projects/{project}/annotationSpecSets/{annotation_spec_set}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`annotationSpecSetId`	`string` The `AnnotationSpecSet` ID. Must not be `null` or empty.

Properties

AnnotationSpecSetId

public string AnnotationSpecSetId { get; }

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

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 AnnotationSpecSetName.ResourceNameType Type { get; }

The AnnotationSpecSetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AnnotationSpecSetNameResourceNameType`

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)

public static string Format(string projectId, string annotationSpecSetId)

Formats the IDs into the string representation of this AnnotationSpecSetName with pattern projects/{project}/annotationSpecSets/{annotation_spec_set}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`annotationSpecSetId`	`string` The `AnnotationSpecSet` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AnnotationSpecSetName with pattern `projects/{project}/annotationSpecSets/{annotation_spec_set}`.

FormatProjectAnnotationSpecSet(string, string)

public static string FormatProjectAnnotationSpecSet(string projectId, string annotationSpecSetId)

Formats the IDs into the string representation of this AnnotationSpecSetName with pattern projects/{project}/annotationSpecSets/{annotation_spec_set}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`annotationSpecSetId`	`string` The `AnnotationSpecSet` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this AnnotationSpecSetName with pattern `projects/{project}/annotationSpecSets/{annotation_spec_set}`.

FromProjectAnnotationSpecSet(string, string)

public static AnnotationSpecSetName FromProjectAnnotationSpecSet(string projectId, string annotationSpecSetId)

Creates a AnnotationSpecSetName with the pattern projects/{project}/annotationSpecSets/{annotation_spec_set}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`annotationSpecSetId`	`string` The `AnnotationSpecSet` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static AnnotationSpecSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AnnotationSpecSetName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/annotationSpecSets/{annotation_spec_set}

Parse(string, bool)

public static AnnotationSpecSetName Parse(string annotationSpecSetName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/annotationSpecSets/{annotation_spec_set}

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

public static bool TryParse(string annotationSpecSetName, out AnnotationSpecSetName result)

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

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

TryParse(string, bool, out AnnotationSpecSetName)

public static bool TryParse(string annotationSpecSetName, bool allowUnparsed, out AnnotationSpecSetName result)

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

Parameters
Name	Description
`annotationSpecSetName`	`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`	`AnnotationSpecSetName` When this method returns, the parsed AnnotationSpecSetName, 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}/annotationSpecSets/{annotation_spec_set}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AnnotationSpecSetName, AnnotationSpecSetName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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