- 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 IndexName : IResourceName, IEquatable<IndexName>
Resource name for the Index
resource.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
IndexName(String, String, String)
public IndexName(string projectId, string locationId, string indexId)
Constructs a new instance of a IndexName class from the component parts of pattern
projects/{project}/locations/{location}/indexes/{index}
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
indexId | String The |
Properties
IndexId
public string IndexId { get; }
The Index
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 |
Boolean |
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 IndexName.ResourceNameType Type { get; }
The IndexName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
IndexName.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, String)
public static string Format(string projectId, string locationId, string indexId)
Formats the IDs into the string representation of this IndexName with pattern
projects/{project}/locations/{location}/indexes/{index}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
indexId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this IndexName with pattern
|
FormatProjectLocationIndex(String, String, String)
public static string FormatProjectLocationIndex(string projectId, string locationId, string indexId)
Formats the IDs into the string representation of this IndexName with pattern
projects/{project}/locations/{location}/indexes/{index}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
indexId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this IndexName with pattern
|
FromProjectLocationIndex(String, String, String)
public static IndexName FromProjectLocationIndex(string projectId, string locationId, string indexId)
Creates a IndexName with the pattern
projects/{project}/locations/{location}/indexes/{index}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
indexId | String The |
Returns | |
---|---|
Type | Description |
IndexName | A new instance of IndexName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static IndexName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a IndexName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
IndexName | A new instance of IndexName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static IndexName Parse(string indexName)
Parses the given resource name string into a new IndexName instance.
Parameter | |
---|---|
Name | Description |
indexName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
IndexName | The parsed IndexName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexes/{index}
Parse(String, Boolean)
public static IndexName Parse(string indexName, bool allowUnparsed)
Parses the given resource name string into a new IndexName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
indexName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
IndexName | The parsed IndexName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexes/{index}
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 IndexName)
public static bool TryParse(string indexName, out IndexName result)
Tries to parse the given resource name string into a new IndexName instance.
Parameters | |
---|---|
Name | Description |
indexName | String The resource name in string form. Must not be |
result | IndexName When this method returns, the parsed IndexName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexes/{index}
TryParse(String, Boolean, out IndexName)
public static bool TryParse(string indexName, bool allowUnparsed, out IndexName result)
Tries to parse the given resource name string into a new IndexName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
indexName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | IndexName When this method returns, the parsed IndexName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexes/{index}
allowUnparsed
is true
.
Operators
Equality(IndexName, IndexName)
public static bool operator ==(IndexName a, IndexName b)
Parameters | |
---|---|
Name | Description |
a | IndexName |
b | IndexName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(IndexName, IndexName)
public static bool operator !=(IndexName a, IndexName b)
Parameters | |
---|---|
Name | Description |
a | IndexName |
b | IndexName |
Returns | |
---|---|
Type | Description |
Boolean |