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.
Namespace
Grafeas.V1Assembly
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}
Properties
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
NoteId
public string NoteId { get; }
The Note
ID. Will not be null
, unless this instance contains an unparsed resource name.
ProjectId
public string ProjectId { get; }
The Project
ID. Will not be null
, unless this instance contains an unparsed resource name.
Type
public NoteName.ResourceNameType Type { get; }
The NoteName.ResourceNameType of the contained resource name.
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName
. Only non- null
if this instance contains an
unparsed resource name.
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}
.
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}
.
FromProjectNote(string, string)
public static NoteName FromProjectNote(string projectId, string noteId)
Creates a NoteName
with the pattern projects/{project}/notes/{note}
.
FromUnparsed(UnparsedResourceName)
public static NoteName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a NoteName containing an unparsed resource name.
unparsedResourceName
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Parse(string)
public static NoteName Parse(string noteName)
Parses the given resource name string into a new NoteName instance.
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.
noteName
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.
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/notes/{note}
allowUnparsed
is true
.ToString()
public override string ToString()
The string representation of the resource name.
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.
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.
noteName
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.
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/notes/{note}
allowUnparsed
is true
.Operators
operator ==(NoteName, NoteName)
public static bool operator ==(NoteName a, NoteName b)
Determines whether two specified resource names have the same value.
true if the value of a
is the same as the value of b
; otherwise,
false.
operator !=(NoteName, NoteName)
public static bool operator !=(NoteName a, NoteName b)
Determines whether two specified resource names have different values.
true if the value of a
is different from the value of b
; otherwise,
false.
