Cloud AI Platform v1 API - Class IndexEndpointName (3.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.

Inheritance

object > IndexEndpointName

Implements

IResourceName, IEquatable IndexEndpointName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`indexEndpointId`	`string` The `IndexEndpoint` ID. Must not be `null` or empty.

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`indexEndpointId`	`string` The `IndexEndpoint` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this IndexEndpointName with pattern `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`.

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`indexEndpointId`	`string` The `IndexEndpoint` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this IndexEndpointName with pattern `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`.

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`indexEndpointId`	`string` The `IndexEndpoint` ID. Must not be `null` or empty.

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 `null`.

Returns
Type	Description
`IndexEndpointName`	A new instance of IndexEndpointName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

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 `null`.

Returns
Type	Description
`IndexEndpointName`	The parsed IndexEndpointName if successful.

Remarks

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 `null`.
`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.

Returns
Type	Description
`IndexEndpointName`	The parsed IndexEndpointName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Or may be in any format if 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.

Overrides

object.ToString()

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 `null`.
`result`	`IndexEndpointName` When this method returns, the parsed IndexEndpointName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

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 `null`.
`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.
`result`	`IndexEndpointName` When this method returns, the parsed IndexEndpointName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(IndexEndpointName, IndexEndpointName)

public static bool operator ==(IndexEndpointName a, IndexEndpointName b)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`IndexEndpointName` The first resource name to compare, or null.
`b`	`IndexEndpointName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(IndexEndpointName, IndexEndpointName)

public static bool operator !=(IndexEndpointName a, IndexEndpointName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`IndexEndpointName` The first resource name to compare, or null.
`b`	`IndexEndpointName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.