- 3.10.0 (latest)
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public sealed class AnnotationName : IResourceName, IEquatable<AnnotationName>
Reference documentation and code samples for the Cloud AI Platform v1 API class AnnotationName.
Resource name for the Annotation
resource.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
AnnotationName(string, string, string, string, string)
public AnnotationName(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)
Constructs a new instance of a AnnotationName class from the component parts of pattern
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
datasetId | string The |
dataItemId | string The |
annotationId | string The |
Properties
AnnotationId
public string AnnotationId { get; }
The Annotation
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
DataItemId
public string DataItemId { get; }
The DataItem
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
DatasetId
public string DatasetId { get; }
The Dataset
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
bool |
LocationId
public string LocationId { get; }
The Location
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 AnnotationName.ResourceNameType Type { get; }
The AnnotationName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
AnnotationNameResourceNameType |
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, string, string, string)
public static string Format(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)
Formats the IDs into the string representation of this AnnotationName with pattern
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
datasetId | string The |
dataItemId | string The |
annotationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this AnnotationName with pattern
|
FormatProjectLocationDatasetDataItemAnnotation(string, string, string, string, string)
public static string FormatProjectLocationDatasetDataItemAnnotation(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)
Formats the IDs into the string representation of this AnnotationName with pattern
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
datasetId | string The |
dataItemId | string The |
annotationId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this AnnotationName with pattern
|
FromProjectLocationDatasetDataItemAnnotation(string, string, string, string, string)
public static AnnotationName FromProjectLocationDatasetDataItemAnnotation(string projectId, string locationId, string datasetId, string dataItemId, string annotationId)
Creates a AnnotationName with the pattern
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
datasetId | string The |
dataItemId | string The |
annotationId | string The |
Returns | |
---|---|
Type | Description |
AnnotationName | A new instance of AnnotationName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static AnnotationName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a AnnotationName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
AnnotationName | A new instance of AnnotationName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static AnnotationName Parse(string annotationName)
Parses the given resource name string into a new AnnotationName instance.
Parameter | |
---|---|
Name | Description |
annotationName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
AnnotationName | The parsed AnnotationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
Parse(string, bool)
public static AnnotationName Parse(string annotationName, bool allowUnparsed)
Parses the given resource name string into a new AnnotationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
annotationName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
AnnotationName | The parsed AnnotationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
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 AnnotationName)
public static bool TryParse(string annotationName, out AnnotationName result)
Tries to parse the given resource name string into a new AnnotationName instance.
Parameters | |
---|---|
Name | Description |
annotationName | string The resource name in string form. Must not be |
result | AnnotationName When this method returns, the parsed AnnotationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
TryParse(string, bool, out AnnotationName)
public static bool TryParse(string annotationName, bool allowUnparsed, out AnnotationName result)
Tries to parse the given resource name string into a new AnnotationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
annotationName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | AnnotationName When this method returns, the parsed AnnotationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}/annotations/{annotation}
allowUnparsed
is true
.
Operators
operator ==(AnnotationName, AnnotationName)
public static bool operator ==(AnnotationName a, AnnotationName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a | AnnotationName The first resource name to compare, or null. |
b | AnnotationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |
operator !=(AnnotationName, AnnotationName)
public static bool operator !=(AnnotationName a, AnnotationName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a | AnnotationName The first resource name to compare, or null. |
b | AnnotationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |