Class NoteName (2.3.0)

public sealed class NoteName : IResourceName, IEquatable<NoteName>

Resource name for theNote resource.

Inheritance

Object >NoteName

Implements

IResourceName,IEquatable<NoteName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Grafeas.V1

Assembly

Grafeas.V1.dll

Constructors

NoteName(String, String)

public NoteName(string projectId, string noteId)

Constructs a new instance of aNoteName class from the component parts of patternprojects/{project}/notes/{note}

Parameters
Name	Description
`projectId`	`String` The`Project` ID. Must not be`null` or empty.
`noteId`	`String` The`Note` ID. Must not be`null` or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`Boolean`

NoteId

public string NoteId { get; }

TheNote ID. Will not benull, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

ProjectId

public string ProjectId { get; }

TheProject ID. Will not benull, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

Type

public NoteName.ResourceNameType Type { get; }

TheNoteName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NoteName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The containedUnparsedResourceName. Only non-null if this instance contains anunparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

Methods

Format(String, String)

public static string Format(string projectId, string noteId)

Formats the IDs into the string representation of thisNoteName with patternprojects/{project}/notes/{note}.

Parameters
Name	Description
`projectId`	`String` The`Project` ID. Must not be`null` or empty.
`noteId`	`String` The`Note` ID. Must not be`null` or empty.

Returns
Type	Description
`String`	The string representation of thisNoteName with pattern`projects/{project}/notes/{note}`.

FormatProjectNote(String, String)

public static string FormatProjectNote(string projectId, string noteId)

Formats the IDs into the string representation of thisNoteName with patternprojects/{project}/notes/{note}.

Parameters
Name	Description
`projectId`	`String` The`Project` ID. Must not be`null` or empty.
`noteId`	`String` The`Note` ID. Must not be`null` or empty.

Returns
Type	Description
`String`	The string representation of thisNoteName with pattern`projects/{project}/notes/{note}`.

FromProjectNote(String, String)

public static NoteName FromProjectNote(string projectId, string noteId)

Creates aNoteName with the patternprojects/{project}/notes/{note}.

Parameters
Name	Description
`projectId`	`String` The`Project` ID. Must not be`null` or empty.
`noteId`	`String` The`Note` ID. Must not be`null` or empty.

Returns
Type	Description
`NoteName`	A new instance ofNoteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NoteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates aNoteName containing an unparsed resource name.

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

Returns
Type	Description
`NoteName`	A new instance ofNoteName containing the provided`unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static NoteName Parse(string noteName)

Parses the given resource name string into a newNoteName instance.

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

Returns
Type	Description
`NoteName`	The parsedNoteName if successful.

Remarks

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

projects/{project}/notes/{note}

Parse(String, Boolean)

public static NoteName Parse(string noteName, bool allowUnparsed)

Parses the given resource name string into a newNoteName instance; optionally allowing anunparseable resource name.

Parameters
Name	Description
`noteName`	`String` The resource name in string form. Must not be`null`.
`allowUnparsed`	`Boolean` If`true` will successfully store an unparseable resource name into theUnparsedResourceproperty; otherwise will throw anArgumentException if an unparseable resource name isspecified.

Returns
Type	Description
`NoteName`	The parsedNoteName if successful.

Remarks

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

projects/{project}/notes/{note}

Or may be in any format ifallowUnparsed istrue.

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

public static bool TryParse(string noteName, out NoteName result)

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

Parameters
Name	Description
`noteName`	`String` The resource name in string form. Must not be`null`.
`result`	`NoteName` When this method returns, the parsedNoteName, 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}/notes/{note}

TryParse(String, Boolean, out NoteName)

public static bool TryParse(string noteName, bool allowUnparsed, out NoteName result)

Tries to parse the given resource name string into a newNoteName instance; optionallyallowing an unparseable resource name.

Parameters
Name	Description
`noteName`	`String` The resource name in string form. Must not be`null`.
`allowUnparsed`	`Boolean` If`true` will successfully store an unparseable resource name into theUnparsedResourceproperty; otherwise will throw anArgumentException if an unparseable resource name isspecified.
`result`	`NoteName` When this method returns, the parsedNoteName, 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}/notes/{note}

Or may be in any format ifallowUnparsed istrue.

Operators

Equality(NoteName, NoteName)

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

Parameters
Name	Description
`a`	`NoteName`
`b`	`NoteName`

Returns
Type	Description
`Boolean`

Inequality(NoteName, NoteName)

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

Parameters
Name	Description
`a`	`NoteName`
`b`	`NoteName`

Returns
Type	Description
`Boolean`

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-29 UTC.

Movatterモバイル変換

Class NoteName (2.3.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Namespace

Assembly

Constructors

NoteName(String, String)

Properties

IsKnownPattern

NoteId

ProjectId

Type

UnparsedResource

Methods

Format(String, String)

FormatProjectNote(String, String)

FromProjectNote(String, String)

FromUnparsed(UnparsedResourceName)

GetHashCode()

Parse(String)

Parse(String, Boolean)

ToString()

TryParse(String, out NoteName)

TryParse(String, Boolean, out NoteName)

Operators

Equality(NoteName, NoteName)

Inequality(NoteName, NoteName)

Class NoteName (2.3.0)