Grafeas v1 API - Class NoteName (3.1.0)

public sealed class NoteName : IResourceName, IEquatable<NoteName>

Reference documentation and code samples for the Grafeas v1 API class NoteName.

Resource name for the Note resource.

Inheritance

object > NoteName

Implements

IResourceName, IEquatable NoteName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

GrafeasV1

Assembly

Grafeas.V1.dll

Constructors

NoteName(string, string)

public NoteName(string projectId, string noteId)

Constructs a new instance of a NoteName class from the component parts of pattern projects/{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
`bool`

NoteId

public string NoteId { get; }

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

The NoteName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NoteNameResourceNameType`

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

Formats the IDs into the string representation of this NoteName with pattern projects/{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 this NoteName 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 this NoteName with pattern projects/{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 this NoteName with pattern `projects/{project}/notes/{note}` .

FromProjectNote(string, string)

public static NoteName FromProjectNote(string projectId, string noteId)

Creates a NoteName with the pattern projects/{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 of NoteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NoteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NoteName 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 of NoteName 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 NoteName Parse(string noteName)

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

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

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

Remarks

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

projects/{project}/notes/{note}

Parse(string, bool)

public static NoteName Parse(string noteName, bool allowUnparsed)

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

Parameters
Name	Description
`noteName`	`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
`NoteName`	The parsed NoteName 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 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 NoteName)

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

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

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

TryParse(string, bool, out NoteName)

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

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

Parameters
Name	Description
`noteName`	`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`	`NoteName` When this method returns, the parsed NoteName, 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}/notes/{note}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NoteName, NoteName)

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

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

Returns
Type	Description
`bool`

operator !=(NoteName, NoteName)

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

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

Returns
Type	Description
`bool`