public sealed class NoteName : IResourceName, IEquatable<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}
Parameters | |
---|---|
Name | Description |
projectId | String The |
noteId | String The |
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; }
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 |
NoteName.ResourceNameType |
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 |
noteId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this NoteName with pattern |
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 |
noteId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this NoteName with pattern |
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 |
noteId | String The |
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 |
Returns | |
---|---|
Type | Description |
NoteName | A new instance of NoteName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
NoteName | The parsed NoteName if successful. |
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 new NoteName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
noteName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
NoteName | The parsed NoteName if successful. |
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.
Returns | |
---|---|
Type | Description |
String | 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.
Parameters | |
---|---|
Name | Description |
noteName | String The resource name in string form. Must not be |
result | NoteName When this method returns, the parsed NoteName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 new NoteName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
noteName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | NoteName When this method returns, the parsed NoteName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/notes/{note}
allowUnparsed
is true
.
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 |