Class AnnotationSpecSetName

Resource name for the AnnotationSpecSet resource.

Inheritance

System.Object

AnnotationSpecSetName

Implements

IResourceName

System.IEquatable<AnnotationSpecSetName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class AnnotationSpecSetName : IResourceName, IEquatable<AnnotationSpecSetName>

Constructors

AnnotationSpecSetName(String, String)

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

Declaration

public AnnotationSpecSetName(string projectId, string annotationSpecSetId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	annotationSpecSetId	The `AnnotationSpecSet` ID. Must not be `null` or empty.

Properties

AnnotationSpecSetId

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

Declaration

public string AnnotationSpecSetId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The AnnotationSpecSetName.ResourceNameType of the contained resource name.

Declaration

public AnnotationSpecSetName.ResourceNameType Type { get; }

Property Value

Type	Description
AnnotationSpecSetName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String)

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

Declaration

public static string Format(string projectId, string annotationSpecSetId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	annotationSpecSetId	The `AnnotationSpecSet` ID. Must not be `null` or empty.

Returns

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

FormatProjectAnnotationSpecSet(String, String)

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

Declaration

public static string FormatProjectAnnotationSpecSet(string projectId, string annotationSpecSetId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	annotationSpecSetId	The `AnnotationSpecSet` ID. Must not be `null` or empty.

Returns

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

FromProjectAnnotationSpecSet(String, String)

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

Declaration

public static AnnotationSpecSetName FromProjectAnnotationSpecSet(string projectId, string annotationSpecSetId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	annotationSpecSetId	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)

Creates a AnnotationSpecSetName containing an unparsed resource name.

Declaration

public static AnnotationSpecSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static AnnotationSpecSetName Parse(string annotationSpecSetName)

Parameters

Type	Name	Description
System.String	annotationSpecSetName	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, Boolean)

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

Declaration

public static AnnotationSpecSetName Parse(string annotationSpecSetName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	annotationSpecSetName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out AnnotationSpecSetName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	annotationSpecSetName	The resource name in string form. Must not be `null`.
AnnotationSpecSetName	result	When this method returns, the parsed AnnotationSpecSetName, or `null` if parsing failed.

Returns

Type	Description
System.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}/annotationSpecSets/{annotation_spec_set}

TryParse(String, Boolean, out AnnotationSpecSetName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	annotationSpecSetName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
AnnotationSpecSetName	result	When this method returns, the parsed AnnotationSpecSetName, or `null` if parsing failed.

Returns

Type	Description
System.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}/annotationSpecSets/{annotation_spec_set}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AnnotationSpecSetName, AnnotationSpecSetName)

Declaration

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

Parameters

Type	Name	Description
AnnotationSpecSetName	a
AnnotationSpecSetName	b

Returns

Type	Description
System.Boolean

Inequality(AnnotationSpecSetName, AnnotationSpecSetName)

Declaration

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

Parameters

Type	Name	Description
AnnotationSpecSetName	a
AnnotationSpecSetName	b

Returns

Type	Description
System.Boolean