- 3.12.0 (latest)
- 3.11.0
- 3.10.0
- 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 IndexEndpointName : IResourceName, IEquatable<IndexEndpointName>
Reference documentation and code samples for the Cloud AI Platform v1 API class IndexEndpointName.
Resource name for the IndexEndpoint
resource.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
IndexEndpointName(string, string, string)
public IndexEndpointName(string projectId, string locationId, string indexEndpointId)
Constructs a new instance of a IndexEndpointName class from the component parts of pattern
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
indexEndpointId | string The |
Properties
IndexEndpointId
public string IndexEndpointId { get; }
The IndexEndpoint
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 IndexEndpointName.ResourceNameType Type { get; }
The IndexEndpointName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
IndexEndpointNameResourceNameType |
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 indexEndpointId)
Formats the IDs into the string representation of this IndexEndpointName with pattern
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
indexEndpointId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this IndexEndpointName with pattern
|
FormatProjectLocationIndexEndpoint(string, string, string)
public static string FormatProjectLocationIndexEndpoint(string projectId, string locationId, string indexEndpointId)
Formats the IDs into the string representation of this IndexEndpointName with pattern
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
indexEndpointId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this IndexEndpointName with pattern
|
FromProjectLocationIndexEndpoint(string, string, string)
public static IndexEndpointName FromProjectLocationIndexEndpoint(string projectId, string locationId, string indexEndpointId)
Creates a IndexEndpointName with the pattern
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
.
Parameters | |
---|---|
Name | Description |
projectId | string The |
locationId | string The |
indexEndpointId | string The |
Returns | |
---|---|
Type | Description |
IndexEndpointName | A new instance of IndexEndpointName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static IndexEndpointName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a IndexEndpointName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
IndexEndpointName | A new instance of IndexEndpointName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static IndexEndpointName Parse(string indexEndpointName)
Parses the given resource name string into a new IndexEndpointName instance.
Parameter | |
---|---|
Name | Description |
indexEndpointName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
IndexEndpointName | The parsed IndexEndpointName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
Parse(string, bool)
public static IndexEndpointName Parse(string indexEndpointName, bool allowUnparsed)
Parses the given resource name string into a new IndexEndpointName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
indexEndpointName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
IndexEndpointName | The parsed IndexEndpointName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
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 IndexEndpointName)
public static bool TryParse(string indexEndpointName, out IndexEndpointName result)
Tries to parse the given resource name string into a new IndexEndpointName instance.
Parameters | |
---|---|
Name | Description |
indexEndpointName | string The resource name in string form. Must not be |
result | IndexEndpointName When this method returns, the parsed IndexEndpointName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
TryParse(string, bool, out IndexEndpointName)
public static bool TryParse(string indexEndpointName, bool allowUnparsed, out IndexEndpointName result)
Tries to parse the given resource name string into a new IndexEndpointName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
indexEndpointName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | IndexEndpointName When this method returns, the parsed IndexEndpointName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
allowUnparsed
is true
.
Operators
operator ==(IndexEndpointName, IndexEndpointName)
public static bool operator ==(IndexEndpointName a, IndexEndpointName b)
Parameters | |
---|---|
Name | Description |
a | IndexEndpointName |
b | IndexEndpointName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(IndexEndpointName, IndexEndpointName)
public static bool operator !=(IndexEndpointName a, IndexEndpointName b)
Parameters | |
---|---|
Name | Description |
a | IndexEndpointName |
b | IndexEndpointName |
Returns | |
---|---|
Type | Description |
bool |